<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="ja" xml:lang="ja">
<head>
	<meta http-equiv="content-type" content="application/xhtml+xml" />
	<meta http-equiv="content-language" content="en" />
	<meta charset="utf-8" />
	<meta name="application-name" content="CliWiki" />
	<title>CliWiki Help</title>
	<link rel="stylesheet" type="text/css" href="compatibility.css" />
	<link rel="stylesheet" type="text/css" href="cliwiki.css" />
	<link rel="stylesheet" type="text/css" href="cliwiki.print.css" media="print "/>
	<link rel="stylesheet" type="text/css" href="cliwiki.help.css" />
	<link rel="SHORTCUT ICON" href="icon_16.png" />
	<script src="jquery-1.7.2.min.js"></script>
	<script src="extension.String.js"></script>
	<script src="extension.Date.js"></script>
	<script src="Preference.js"></script>
	<script src="CliWikiFormatter.js"></script>
	<script src="WikiPageStocker.js"></script>
	<script src="CliWikiUI.js"></script>
	<script src="CliWikiHelp.js"></script>
</head>
<body role="application">
	<header id="pageHeader" role="banner">
		<h1><img class="icon" src="./res/chestnut.svg" align="left" />CliWiki Help</h1>
	</header>
	<div id="content">
		<div id="row">
			<aside id="sideBarMenu" role="complementary">
				<nav role="navigation">
					<h1>Contents</h1>
					<ul id="contentList">
					</ul>
				</nav>
				<nav>
					<h1>Recent updates</h1>
					<ul id="historyList">
						<li><a href="#0.1.1.2(20120808)">0.1.1.2(20120808)</a></li>
					</ul>
				</nav>
			</aside>
			<div id="sectionContainer">
				<section id="usage">
					<h1>Usage</h1>
					<article>
						<h2>Structure of page</h2>
						<p>CliWiki handles the page as a set of the following informations:</p>
						<ul>
							<li>Page name</li>
							<li>Title</li>
							<li>Page body</li>
							<li>Last update time</li>
						</ul>
						<h3>Page name and WikiName</h3>
						<p>Page name must be specified in WikiName. WikiName is a word that satisfy the following conditions:</p>
					<ol>
						<li>Separated by spaces or new line.</li>
						<li>First is a capital letter and followed by lower case letter or number.</li>
						<li>Repeat 2., two or more times.</li>
					</ol>
<p>When you describe a WikiName in the page body, it's automatically linked to the page. It's easy to associate the page and page by describing the WikiName.<br />
	If the page dosen't exist, new page editor will be linked.</p>
<p>You can browse page names by &ldquo;page list&rdquo;.</p>
					</article>
					<article>
						<h2>Edit page</h2>
						<p>You can start editing the page by selecting &ldquo;Edit&rdquo; button. Please describe text using <a href="#format">Markup syntax</a>. You can see the translation result of writing at the area under the editor.</p>
						<p>To save edits, please select &ldquo;Update&rdquo; button. To discard edits, please select &ldquo;Cancel&rdquo; button. Please note that will not be recovered edits have been discarded.</p>
					</article>
					<article>
						<h2>Add page</h2>
						<p>To add the page, operations are following:</p>
						<ul>
							<li>Add from an existing page</li>
							<li>Add from side bar</li>
						</ul>
						<h3>Add from an existing page</h3>
						<p>If the WikiName doesn't exist, question mark appears after the WikiName. You can start editing new page by selecting link of the question mark. Add a new page by selecting the &ldquo;Update&rdquo; button after editing.</p>

						<h3>Add from side bar</h3>
						<p>You can start editing by entering the new page WikiName in the input field on the side bar and selecting &ldquo;&gt;&gt;&rdquo; button(show the page if exists). Add a new page by selecting the &ldquo;Update&rdquo; button after editing.</p>
					</article>
					<article>
						<h2>Delete page</h2>
						<p>To delete the page, you start editing and clear all text of the text editor, and select the &ldquo;Update&rdquo; button. And then confirmation message appears, please select the &ldquo;OK&rdquo; button. And then the page will be deleted.</p>
						<p><strong>Caution: The deleted page can't be recovered. Please check carefully when you want to delete.</strong></p>
						<p>You can't delete the FrontPage.</p>
					</article>
					<article>
						<h2>Search</h2>
						<p>You can search the page by entering search words in the input field on the global menu and selecting &ldquo;Search&rdquo; button.<br />
							Uppercase and lowercase letters of the alphabet are distinguished.<br />
							You can specify more than one word by separated by spaces. Search the page that contains any word if you specify more than one word. Please enclose by double quotes(&quot;) if you want to search for phrase that contain spaces.</p>
					</article>
				</section>
				<section id="format">
					<h1>Markup syntax</h1>
					<p>You can select following markup syntax:</p>
					<ul>
						<li>CliWiki syntax(almost compatible with <a href="http://hikiwiki.org/ja/?TextFormattingRules" target="_blank">Hiki syntax</a>)</li>
						<li><a href="http://daringfireball.net/projects/markdown/" target="_blank">Markdown</a> syntax</li>
					</ul>
					<p>It can also be specified for each page when editing.It can also be specified for each page when editing.</p>

					<p>Please see the following web page for Markdown syntax:</p>
					<ul>
						<li><a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown Syntax Documentation</a></li>
					</ul>

					<p>CliWiki syntax is as follows.</p>
					<h2>Block Elements</h2>
					<h3>Heading</h3>
					<p>The line starting with '!' will be heading. Number of '!' indicates the level of heading.</p>
					<h3>Horizontal line</h3>
					<p>The line '----' will be horizontal line like following:</p>
					<hr />
					<h3>List</h3>
					<h4>Unordered list</h4>
					<p>Continuous lines starting with '*' will be unordered list.</p>
					<h5>Markup</h5><pre>* Item 1
** Item 1 of 1
** Item 2 of 1
* Item 2
* Item 3</pre>
					<h5>Translation</h5>
					<ul>
						<li>Item 1
							<ul>
								<li>Item 1 of 1</li>
								<li>Item 2 of 1</li>
							</ul>
						</li>
						<li>Item 2</li>
						<li>Item 3</li>
					</ul>
					<h4>Ordered list</h4>
					<p>Continuous lines starting with '#' will be ordered list.</p>
					<h5>Markup</h5><pre># Item 1
# Item 2
## Item 1 of 2
## Item 2 of 2
# Item 3</pre>
					<h5> Translation</h5>
					<ol>
						<li>Item 1</li>
						<li>Item 2
							<ol>
								<li>Item 1 of 2</li>
								<li>Item 2 of 2</li>
							</ol>
						</li>
						<li>Item 3</li>
					</ol>
					<h3>Glossary</h3>
					<p>The text corresponding to following conditions will be treated as a glossary.</p>
					<ul>
						<li>Starting with ':'.</li>
						<li>Describe term before ':' and describe remark after ':'.</li>
					</ul>
					<h4>Markup</h4>
					<pre>:Heading of the term 1:Explanation of the term 1
:Heading of the term 2:Explanation of the term 2
:Heading of the term 3:Explanation of the term 3</pre>
					<h4> Translation</h4>
					<dl>
						<dt>Heading of the term 1</dt>
						<dd>Explanation of the term 1</dd>
						<dt>Heading of the term 2</dt>
						<dd>Explanation of the term 2</dd>
						<dt>Heading of the term 3</dt>
						<dd>Explanation of the term 3</dd>
					</dl>
					<h3>Preformatted text</h3>
					<p>The line starting with space(U+0020) or tab will be preformetted text.</p>
					<pre>Preformatted text
retain the new line.</pre>
					<p>Lines between the line '<<<' and '>>>' considered as a preformatted text.</p>
					<h3>Table</h3>
					<p>Continuous lines starting '||' will be translate as a table. '||' is a separator of cell, but not required at the end of line.</p><p>The cell that contains the text starting with &ldquo;!&rdquo; will be heading cell. Start character of the cell text denotes concatenation. &ldquo;^&rdquo; denotes row direction, &ldquo;>&rdquo; denotes column direction. Number of character indicates concatenation number.</p>
					<h4>Markup</h4>
					<pre>||!Heading of line / column||!A||!B||!C||!&gt;D-E
||!1||A1||B1||^C1-C2||D1||E1
||!2||A2||B2||^&gt;D2-E2-D3-E3
||!3||A3||B3||C3</pre>
					<h4> Translation</h4>
					<table border="1">
						<tbody>
							<tr>
								<th>Heading of line / column</th><th>A</th><th>B</th><th>C</th><th colspan="2">D-E</th>
							</tr>
							<tr>
								<th>1</th><td>A1</td><td>B1</td><td rowspan="2">C1-C2</td><td>D1</td><td>E1</td>
							</tr>
							<tr>
								<th>2</th><td>A2</td><td>B2</td><td rowspan="2" colspan="2">D2-E2-D3-E3</td>
							</tr>
							<tr>
								<th>3</th><td>A3</td><td>B3</td><td>C3</td>
							</tr>
						</tbody>
					</table>
					<h3>Comment</h3>
					<p>The line starting with '//' is treated as a comment, not translate.</p>
					<h3>Otherwise</h3>
					<p>It becomes ordinary paragraph other than the above.</p>
					<p>Paragraph will change when you describe the blank line. Continuous lines are considered to be a paragraph.</p>
					<h4>Markup</h4>
					<pre>It becomes ordinary paragraph other than the above.

Paragraph will change when you describe the blank line.
Continuous lines are considered to be a paragraph.</pre>
					<h4>Translation</h4>
					<p>It becomes ordinary paragraph other than the above.</p>
					<p>Paragraph will change when you describe the blank line. Continuous lines are considered to be a paragraph.</p>
					<h2>Span elements</h2>
					<h3>Image and web url Auto-link</h3>
					<p>The url corresponding to following conditions will be treated as an image or link.</p>
					<ol>
						<li>Separated by spaces or new line.</li>
						<li>Starting with 'http://' or 'https://'.</li>
					</ol>
					<p>Show the image if link target is an image. Otherwise link to url.</p>
					<h3>An explicit link</h3>
					<p>The text corresponding to following conditions will be treated as a link.</p>
					<ul>
						<li>Starting with  '[['.</li>
						<li>Ending with ']]'.</li>
						<li>Describe literal before '|' and describe url after '|'.</li>
					</ul>
					<h3>Text decoration</h3>
					<ul>
						<li>The text enclosed by &ldquo;''&rdquo; will be <em>emphasized</em>.</li>
						<li>The text enclosed by &ldquo;'''&rdquo; will be <strong>strongly emphasized</strong>.</li>
						<li>The text enclosed by '==' will be <del>decorated with a strikeout</del>.</li>
					</ul>
				</section>
				<section id="roadmap">
					<h1>Future plans</h1>
					<h2>General</h2>
					<ul>
						<li>Update jQuery to latest version.</li>
						<li>Mobile device support.</li>
						<li>Better printing support.</li>
					</ul>
					<h2>Ideas under consideration</h2>
					<ul>
						<li>Cooperation with public web services.
							<ul>
								<li>Google document spreadsheet</li>
								<li>Dropbox</li>
								<li>OneDrive</li>
								<li>Google Drive</li>
								<li>Amazon S3</li>
								<li>iCloud(?)</li>
							</ul>
						</li>
						<li>Customize the configuration.</li>
						<li>Handle line drawing(using Canvas / SVG).</li>
						<li>Implement a plug-in architecture.</li>
						<li>Add more unit test.</li>
						<li>Multilingualization.</li>
						<li>Recording position information when updated.</li>
						<li>Export HTML translated page.</li>
						<li>Select enable /disable realtime preview at edit.</li>
					</ul>
				</section>
				<section id="contactUs">
					<h1>Contact us</h1>
					<p>CliWiki is the HTML5 application that developed and distributed by <a href="http://www.est.co.jp/english" target="_blank">EAST Co., Ltd</a>.</p>
					<p>If you want to contact for business, please access <a href="http://est.jp/html5/" target="_blank">est.jp - HTML5</a>(Sorry, Japanese only).</p>
					<p><img class="logo" src="./res/f_logo.svg" align="left" />If you have a feedback or technical inquiries, please post to <a href="http://www.facebook.com/groups/HTML5east/" target="_blank">the &ldquo;html5east&rdquo; group of Facebook</a>(Sorry, Japanese only too).</p>
					<h2>Project information</h2>
					<p>CliWiki is available as an <a href="http://cliwiki.codeplex.com/" target="_blank">open source project</a> at <a href="http://www.codeplex.com/" target="_blank">CodePlex</a>.</p>
					<h3>Using software</h3>
					<p>CliWiki uses following open source softwares for development. Thank you so much to all developers.</p>
					<h4><a href="http://jquery.com/" target="_blank">jQuery</a> 1.7.2</h4>
					<blockquote cite="http://jquery.com/">jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript.</blockquote>
					<h4><a href="https://github.com/chjj/marked" target="_blank">marked</a> 2013-08-24</h4>
					<blockquote cite="https://github.com/chjj/marked">A markdown parser and compiler. Built for speed.</blockquote>
					<h4><a href="http://pivotal.github.io/jasmine/" target="_blank">Jasmine</a> 1.3.1</h4>
					<blockquote cite="http://pivotal.github.io/jasmine/">Jasmine is a behavior-driven development framework for testing JavaScript code. It does not depend on any other JavaScript frameworks. It does not require a DOM. And it has a clean, obvious syntax so that you can easily write tests.</blockquote>
				</section>
				<section id="updateHistory">
					<h1>Recent updates</h1>
					<h2 id="0.6.1.1(20140418)">0.6.1.1(20140418)</h2>
					<ul>
						<li>Implement page data export and import function.</li>
						<li>Implement adjust contents editor height function.</li>
						<li>Implement cancel latest update function.</li>
					</ul>
					<h2 id="0.5.1.1(20130925)">0.5.1.1(20130925)</h2>
					<ul>
						<li>Add <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown syntax</a> support.</li>
						<li>Fix: A WikiName at the end of line will not translate to link(using CliWiki syntax).</li>
					</ul>
					<h2 id="0.4.1.1(20121113)">0.4.1.1(20121113)</h2>
					<ul>
						<li>Implement function to show the difference between the revision of the page.</li>
					</ul>
					<h2 id="0.3.1.1(20120919)">0.3.1.1(20120919)</h2>
					<ul>
						<li>Implement search function.</li>
						<li>Add user interface's english description and language selection function.</li>
					</ul>
					<h2 id="0.2.2.1(20120904)">0.2.2.1(20120904)</h2>
					<ul>
						<li>Add function to enable a link to a local file by setting(but disabled if you installed from Chrome Web Store, due to limitation of Chrome).</li>
					</ul>
					<h2 id="0.2.1.3(20120815)">0.2.1.3(20120815)</h2>
					<ul>
						<li>Add page revision history management, function to show the specified revision of the page.</li>
					</ul>
					<h2 id="0.1.1.3(20120810)">0.1.1.3(20120810)</h2>
					<ul>
						<li>Revised the translation process of text that is stored in elements of a list.</li>
						<li>Revised the process of heading without text.</li>
					</ul>
					<h2 id="0.1.1.2(20120808)">0.1.1.2(20120808)</h2>
					<p>First release of Packaged App version for Chrome Web Store.</p>
				</section>
			</div>
		</div>
	</div>
	<footer id="pageFooter" role="contentInfo">
		<p id="version">CliWiki Ver.0.01.005</p>
		<p><a href="http://www.est.co.jp" target="_blank">EAST Co., Ltd.</a></p>
	</footer>
</body>
</html>
